@solana/spl-token

What is @solana/spl-token?

@solana/spl-token is an npm package that provides a set of tools and utilities for interacting with the Solana blockchain's SPL Token program. This package allows developers to create, manage, and interact with SPL tokens, which are the standard tokens on the Solana blockchain.

What are @solana/spl-token's main functionalities?

Create a New Token

This feature allows you to create a new SPL token on the Solana blockchain. The code sample demonstrates how to set up a connection to the Solana network, generate keypairs for the payer, mint authority, and freeze authority, and then create a new token with specified decimal places.

const { Connection, Keypair } = require('@solana/web3.js');
const { createMint } = require('@solana/spl-token');

(async () => {
  const connection = new Connection('https://api.mainnet-beta.solana.com');
  const payer = Keypair.generate();
  const mintAuthority = Keypair.generate();
  const freezeAuthority = Keypair.generate();

  const mint = await createMint(
    connection,
    payer,
    mintAuthority.publicKey,
    freezeAuthority.publicKey,
    9 // Decimals
  );
  console.log('Created new token:', mint.toBase58());
})();

Create a Token Account

This feature allows you to create a new token account for a specific SPL token. The code sample demonstrates how to set up a connection, generate keypairs for the payer, mint, and owner, and then create a new token account associated with the specified mint and owner.

const { Connection, Keypair } = require('@solana/web3.js');
const { createAccount } = require('@solana/spl-token');

(async () => {
  const connection = new Connection('https://api.mainnet-beta.solana.com');
  const payer = Keypair.generate();
  const mint = Keypair.generate(); // Assume this is your token mint
  const owner = Keypair.generate();

  const tokenAccount = await createAccount(
    connection,
    payer,
    mint.publicKey,
    owner.publicKey
  );
  console.log('Created new token account:', tokenAccount.toBase58());
})();

Mint New Tokens

This feature allows you to mint new tokens to a specified token account. The code sample demonstrates how to set up a connection, generate keypairs for the payer, mint, destination account, and mint authority, and then mint a specified amount of tokens to the destination account.

const { Connection, Keypair } = require('@solana/web3.js');
const { mintTo } = require('@solana/spl-token');

(async () => {
  const connection = new Connection('https://api.mainnet-beta.solana.com');
  const payer = Keypair.generate();
  const mint = Keypair.generate(); // Assume this is your token mint
  const destination = Keypair.generate(); // Assume this is your token account
  const mintAuthority = Keypair.generate();

  await mintTo(
    connection,
    payer,
    mint.publicKey,
    destination.publicKey,
    mintAuthority,
    1000000 // Amount to mint
  );
  console.log('Minted new tokens');
})();

Transfer Tokens

This feature allows you to transfer tokens from one token account to another. The code sample demonstrates how to set up a connection, generate keypairs for the payer, source account, destination account, and owner, and then transfer a specified amount of tokens from the source account to the destination account.

const { Connection, Keypair } = require('@solana/web3.js');
const { transfer } = require('@solana/spl-token');

(async () => {
  const connection = new Connection('https://api.mainnet-beta.solana.com');
  const payer = Keypair.generate();
  const source = Keypair.generate(); // Assume this is your source token account
  const destination = Keypair.generate(); // Assume this is your destination token account
  const owner = Keypair.generate();

  await transfer(
    connection,
    payer,
    source.publicKey,
    destination.publicKey,
    owner,
    500000 // Amount to transfer
  );
  console.log('Transferred tokens');
})();

Other packages similar to @solana/spl-token

@solana/web3.js

@solana/web3.js is a JavaScript API for interacting with the Solana blockchain. While it provides lower-level functionalities for interacting with the Solana network, it does not specifically focus on SPL tokens like @solana/spl-token does. However, it is often used in conjunction with @solana/spl-token for broader Solana development.

@project-serum/serum

@project-serum/serum is a package for interacting with the Serum decentralized exchange on the Solana blockchain. While it provides functionalities for trading and market-making, it does not focus on the creation and management of SPL tokens like @solana/spl-token.

@solana/spl-governance

@solana/spl-governance is a package for creating and managing governance structures on the Solana blockchain. While it provides tools for decentralized governance, it does not offer the same token management functionalities as @solana/spl-token.

README

@solana/spl-token

A TypeScript library for interacting with the SPL Token and Token-2022 programs.

Links

• TypeScript Docs
• FAQs (Frequently Asked Questions)
• Install
• Build from Source

FAQs

How can I get support?

Please ask questions in the Solana Stack Exchange: https://solana.stackexchange.com/

If you've found a bug or you'd like to request a feature, please open an issue.

No export named Token

Please see upgrading from 0.1.x.

Install

npm install --save @solana/spl-token @solana/web3.js

OR

yarn add @solana/spl-token @solana/web3.js

Build from Source

1. Prerequisites

• Node 16+
• PNPM

If you have Node 16+, you can activate PNPM with Corepack.

1. Clone the project:

git clone https://github.com/solana-labs/solana-program-library.git

1. Navigate to the root of the repository:

cd solana-program-library

1. Install the dependencies:

pnpm install

1. Build the libraries in the repository:

pnpm run build

1. Navigate to the SPL Token library:

cd token/js

1. Build the on-chain programs:

pnpm run test:build-programs

1. Run the tests:

pnpm run test

1. Run the example:

pnpm run example

Upgrading

Upgrading from 0.2.0

There are no breaking changes from 0.2.0, only new functionality for Token-2022.

Upgrading from 0.1.x

When upgrading from spl-token 0.1.x, you may see the following error in your code:

import {TOKEN_PROGRAM_ID, Token, AccountLayout} from '@solana/spl-token';
                          ^^^^^
SyntaxError: The requested module '@solana/spl-token' does not provide an export named 'Token'

The @solana/spl-token library as of version 0.2.0 does not have the Token class. Instead the actions are split up and exported separately.

To use the old version, install it with:

npm install @solana/spl-token@0.1.8

Otherwise you can find documentation on how to use new versions on the SPL docs or Solana Cookbook.